Skip to content

docs(tracer): extract code examples #730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from

Conversation

michaelbrewer
Copy link
Contributor

@michaelbrewer michaelbrewer commented Apr 5, 2022

Description of your changes

Extract code examples in the tracer documentation

Changes:

  • group extracted examples under docs/examples/core/tracer/ folder
  • fix indents to match the projects code style of 2 spaces
  • fix the sam template.yml example, by adding missing fields
  • fix missing import for Context tracing https requests example

Resolves #729

No specific dependencies, but improvements could be made to validate the code examples and allow for this to be a scalable option.

How to verify this change

Run npm run docs-runLocalDocker and the code examples in the docs should render the same.

Related issues, RFCs

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

Breaking change checklist

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi added blocked This item's progress is blocked by external dependency or reason documentation Improvements or additions to documentation labels Apr 5, 2022
@michaelbrewer
Copy link
Contributor Author

I will eventually get back to this.

@dreamorosi
Copy link
Contributor

Okay, thanks for the heads up @michaelbrewer :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked This item's progress is blocked by external dependency or reason documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Extract code examples into separate files for linting
2 participants